<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>OrderedMemoryAwareThreadPoolExecutor xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../api/org/jboss/netty/handler/execution/OrderedMemoryAwareThreadPoolExecutor.html">View Javadoc</a></div><pre>

<a class="jxr_linenumber" name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a>   <em class="jxr_comment"> * Copyright 2009 Red Hat, Inc.</em>
<a class="jxr_linenumber" name="3" href="#3">3</a>   <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="4" href="#4">4</a>   <em class="jxr_comment"> * Red Hat licenses this file to you under the Apache License, version 2.0</em>
<a class="jxr_linenumber" name="5" href="#5">5</a>   <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with the</em>
<a class="jxr_linenumber" name="6" href="#6">6</a>   <em class="jxr_comment"> * License.  You may obtain a copy of the License at:</em>
<a class="jxr_linenumber" name="7" href="#7">7</a>   <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="8" href="#8">8</a>   <em class="jxr_comment"> *    <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a class="jxr_linenumber" name="9" href="#9">9</a>   <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="10" href="#10">10</a>  <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a class="jxr_linenumber" name="11" href="#11">11</a>  <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT</em>
<a class="jxr_linenumber" name="12" href="#12">12</a>  <em class="jxr_comment"> * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the</em>
<a class="jxr_linenumber" name="13" href="#13">13</a>  <em class="jxr_comment"> * License for the specific language governing permissions and limitations</em>
<a class="jxr_linenumber" name="14" href="#14">14</a>  <em class="jxr_comment"> * under the License.</em>
<a class="jxr_linenumber" name="15" href="#15">15</a>  <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="16" href="#16">16</a>  <strong class="jxr_keyword">package</strong> org.jboss.netty.handler.execution;
<a class="jxr_linenumber" name="17" href="#17">17</a>  
<a class="jxr_linenumber" name="18" href="#18">18</a>  <strong class="jxr_keyword">import</strong> java.util.IdentityHashMap;
<a class="jxr_linenumber" name="19" href="#19">19</a>  <strong class="jxr_keyword">import</strong> java.util.LinkedList;
<a class="jxr_linenumber" name="20" href="#20">20</a>  <strong class="jxr_keyword">import</strong> java.util.Set;
<a class="jxr_linenumber" name="21" href="#21">21</a>  <strong class="jxr_keyword">import</strong> java.util.WeakHashMap;
<a class="jxr_linenumber" name="22" href="#22">22</a>  <strong class="jxr_keyword">import</strong> java.util.concurrent.ConcurrentMap;
<a class="jxr_linenumber" name="23" href="#23">23</a>  <strong class="jxr_keyword">import</strong> java.util.concurrent.Executor;
<a class="jxr_linenumber" name="24" href="#24">24</a>  <strong class="jxr_keyword">import</strong> java.util.concurrent.ThreadFactory;
<a class="jxr_linenumber" name="25" href="#25">25</a>  <strong class="jxr_keyword">import</strong> java.util.concurrent.TimeUnit;
<a class="jxr_linenumber" name="26" href="#26">26</a>  
<a class="jxr_linenumber" name="27" href="#27">27</a>  <strong class="jxr_keyword">import</strong> org.jboss.netty.channel.Channel;
<a class="jxr_linenumber" name="28" href="#28">28</a>  <strong class="jxr_keyword">import</strong> org.jboss.netty.channel.ChannelEvent;
<a class="jxr_linenumber" name="29" href="#29">29</a>  <strong class="jxr_keyword">import</strong> org.jboss.netty.channel.ChannelState;
<a class="jxr_linenumber" name="30" href="#30">30</a>  <strong class="jxr_keyword">import</strong> org.jboss.netty.channel.ChannelStateEvent;
<a class="jxr_linenumber" name="31" href="#31">31</a>  <strong class="jxr_keyword">import</strong> org.jboss.netty.util.ObjectSizeEstimator;
<a class="jxr_linenumber" name="32" href="#32">32</a>  <strong class="jxr_keyword">import</strong> org.jboss.netty.util.internal.ConcurrentIdentityWeakKeyHashMap;
<a class="jxr_linenumber" name="33" href="#33">33</a>  
<a class="jxr_linenumber" name="34" href="#34">34</a>  <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="35" href="#35">35</a>  <em class="jxr_javadoccomment"> * A {@link MemoryAwareThreadPoolExecutor} which makes sure the events from the</em>
<a class="jxr_linenumber" name="36" href="#36">36</a>  <em class="jxr_javadoccomment"> * same {@link Channel} are executed sequentially.</em>
<a class="jxr_linenumber" name="37" href="#37">37</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="38" href="#38">38</a>  <em class="jxr_javadoccomment"> * &lt;b&gt;NOTE&lt;/b&gt;: This thread pool inherits most characteristics of its super</em>
<a class="jxr_linenumber" name="39" href="#39">39</a>  <em class="jxr_javadoccomment"> * type, so please make sure to refer to {@link MemoryAwareThreadPoolExecutor}</em>
<a class="jxr_linenumber" name="40" href="#40">40</a>  <em class="jxr_javadoccomment"> * to understand how it works basically.</em>
<a class="jxr_linenumber" name="41" href="#41">41</a>  <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="42" href="#42">42</a>  <em class="jxr_javadoccomment"> * &lt;h3&gt;Event execution order&lt;/h3&gt;</em>
<a class="jxr_linenumber" name="43" href="#43">43</a>  <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="44" href="#44">44</a>  <em class="jxr_javadoccomment"> * For example, let's say there are two executor threads that handle the events</em>
<a class="jxr_linenumber" name="45" href="#45">45</a>  <em class="jxr_javadoccomment"> * from the two channels:</em>
<a class="jxr_linenumber" name="46" href="#46">46</a>  <em class="jxr_javadoccomment"> * &lt;pre&gt;</em>
<a class="jxr_linenumber" name="47" href="#47">47</a>  <em class="jxr_javadoccomment"> *           -------------------------------------&amp;gt; Timeline ------------------------------------&amp;gt;</em>
<a class="jxr_linenumber" name="48" href="#48">48</a>  <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="49" href="#49">49</a>  <em class="jxr_javadoccomment"> * Thread X: --- Channel A (Event A1) --.   .-- Channel B (Event B2) --- Channel B (Event B3) ---&amp;gt;</em>
<a class="jxr_linenumber" name="50" href="#50">50</a>  <em class="jxr_javadoccomment"> *                                      \ /</em>
<a class="jxr_linenumber" name="51" href="#51">51</a>  <em class="jxr_javadoccomment"> *                                       X</em>
<a class="jxr_linenumber" name="52" href="#52">52</a>  <em class="jxr_javadoccomment"> *                                      / \</em>
<a class="jxr_linenumber" name="53" href="#53">53</a>  <em class="jxr_javadoccomment"> * Thread Y: --- Channel B (Event B1) --'   '-- Channel A (Event A2) --- Channel A (Event A3) ---&amp;gt;</em>
<a class="jxr_linenumber" name="54" href="#54">54</a>  <em class="jxr_javadoccomment"> * &lt;/pre&gt;</em>
<a class="jxr_linenumber" name="55" href="#55">55</a>  <em class="jxr_javadoccomment"> * As you see, the events from different channels are independent from each</em>
<a class="jxr_linenumber" name="56" href="#56">56</a>  <em class="jxr_javadoccomment"> * other.  That is, an event of Channel B will not be blocked by an event of</em>
<a class="jxr_linenumber" name="57" href="#57">57</a>  <em class="jxr_javadoccomment"> * Channel A and vice versa, unless the thread pool is exhausted.</em>
<a class="jxr_linenumber" name="58" href="#58">58</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="59" href="#59">59</a>  <em class="jxr_javadoccomment"> * Also, it is guaranteed that the invocation will be made sequentially for the</em>
<a class="jxr_linenumber" name="60" href="#60">60</a>  <em class="jxr_javadoccomment"> * events from the same channel.  For example, the event A2 is never executed</em>
<a class="jxr_linenumber" name="61" href="#61">61</a>  <em class="jxr_javadoccomment"> * before the event A1 is finished.  (Although not recommended, if you want the</em>
<a class="jxr_linenumber" name="62" href="#62">62</a>  <em class="jxr_javadoccomment"> * events from the same channel to be executed simultaneously, please use</em>
<a class="jxr_linenumber" name="63" href="#63">63</a>  <em class="jxr_javadoccomment"> * {@link MemoryAwareThreadPoolExecutor} instead.)</em>
<a class="jxr_linenumber" name="64" href="#64">64</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="65" href="#65">65</a>  <em class="jxr_javadoccomment"> * However, it is not guaranteed that the invocation will be made by the same</em>
<a class="jxr_linenumber" name="66" href="#66">66</a>  <em class="jxr_javadoccomment"> * thread for the same channel.  The events from the same channel can be</em>
<a class="jxr_linenumber" name="67" href="#67">67</a>  <em class="jxr_javadoccomment"> * executed by different threads.  For example, the Event A2 is executed by the</em>
<a class="jxr_linenumber" name="68" href="#68">68</a>  <em class="jxr_javadoccomment"> * thread Y while the event A1 was executed by the thread X.</em>
<a class="jxr_linenumber" name="69" href="#69">69</a>  <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="70" href="#70">70</a>  <em class="jxr_javadoccomment"> * &lt;h3&gt;Using a different key other than {@link Channel} to maintain event order&lt;/h3&gt;</em>
<a class="jxr_linenumber" name="71" href="#71">71</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="72" href="#72">72</a>  <em class="jxr_javadoccomment"> * {@link OrderedMemoryAwareThreadPoolExecutor} uses a {@link Channel} as a key</em>
<a class="jxr_linenumber" name="73" href="#73">73</a>  <em class="jxr_javadoccomment"> * that is used for maintaining the event execution order, as explained in the</em>
<a class="jxr_linenumber" name="74" href="#74">74</a>  <em class="jxr_javadoccomment"> * previous section.  Alternatively, you can extend it to change its behavior.</em>
<a class="jxr_linenumber" name="75" href="#75">75</a>  <em class="jxr_javadoccomment"> * For example, you can change the key to the remote IP of the peer:</em>
<a class="jxr_linenumber" name="76" href="#76">76</a>  <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="77" href="#77">77</a>  <em class="jxr_javadoccomment"> * &lt;pre&gt;</em>
<a class="jxr_linenumber" name="78" href="#78">78</a>  <em class="jxr_javadoccomment"> * public class RemoteAddressBasedOMATPE extends {@link OrderedMemoryAwareThreadPoolExecutor} {</em>
<a class="jxr_linenumber" name="79" href="#79">79</a>  <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="80" href="#80">80</a>  <em class="jxr_javadoccomment"> *     ... Constructors ...</em>
<a class="jxr_linenumber" name="81" href="#81">81</a>  <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="82" href="#82">82</a>  <em class="jxr_javadoccomment"> *     {@code @Override}</em>
<a class="jxr_linenumber" name="83" href="#83">83</a>  <em class="jxr_javadoccomment"> *     protected ConcurrentMap&amp;lt;Object, Executor&amp;gt; newChildExecutorMap() {</em>
<a class="jxr_linenumber" name="84" href="#84">84</a>  <em class="jxr_javadoccomment"> *         // The default implementation returns a special ConcurrentMap that</em>
<a class="jxr_linenumber" name="85" href="#85">85</a>  <em class="jxr_javadoccomment"> *         // uses identity comparison only (see {@link IdentityHashMap}).</em>
<a class="jxr_linenumber" name="86" href="#86">86</a>  <em class="jxr_javadoccomment"> *         // Because SocketAddress does not work with identity comparison,</em>
<a class="jxr_linenumber" name="87" href="#87">87</a>  <em class="jxr_javadoccomment"> *         // we need to employ more generic implementation.</em>
<a class="jxr_linenumber" name="88" href="#88">88</a>  <em class="jxr_javadoccomment"> *         return new ConcurrentHashMap&amp;lt;Object, Executor&amp;gt;</em>
<a class="jxr_linenumber" name="89" href="#89">89</a>  <em class="jxr_javadoccomment"> *     }</em>
<a class="jxr_linenumber" name="90" href="#90">90</a>  <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="91" href="#91">91</a>  <em class="jxr_javadoccomment"> *     protected Object getChildExecutorKey({@link ChannelEvent} e) {</em>
<a class="jxr_linenumber" name="92" href="#92">92</a>  <em class="jxr_javadoccomment"> *         // Use the IP of the remote peer as a key.</em>
<a class="jxr_linenumber" name="93" href="#93">93</a>  <em class="jxr_javadoccomment"> *         return ((InetSocketAddress) e.getChannel().getRemoteAddress()).getAddress();</em>
<a class="jxr_linenumber" name="94" href="#94">94</a>  <em class="jxr_javadoccomment"> *     }</em>
<a class="jxr_linenumber" name="95" href="#95">95</a>  <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="96" href="#96">96</a>  <em class="jxr_javadoccomment"> *     // Make public so that you can call from anywhere.</em>
<a class="jxr_linenumber" name="97" href="#97">97</a>  <em class="jxr_javadoccomment"> *     public boolean removeChildExecutor(Object key) {</em>
<a class="jxr_linenumber" name="98" href="#98">98</a>  <em class="jxr_javadoccomment"> *         super.removeChildExecutor(key);</em>
<a class="jxr_linenumber" name="99" href="#99">99</a>  <em class="jxr_javadoccomment"> *     }</em>
<a class="jxr_linenumber" name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * }</em>
<a class="jxr_linenumber" name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * &lt;/pre&gt;</em>
<a class="jxr_linenumber" name="102" href="#102">102</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * Please be very careful of memory leak of the child executor map.  You must</em>
<a class="jxr_linenumber" name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * call {@link #removeChildExecutor(Object)} when the life cycle of the key</em>
<a class="jxr_linenumber" name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * ends (e.g. all connections from the same IP were closed.)  Also, please</em>
<a class="jxr_linenumber" name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * keep in mind that the key can appear again after calling {@link #removeChildExecutor(Object)}</em>
<a class="jxr_linenumber" name="107" href="#107">107</a> <em class="jxr_javadoccomment"> * (e.g. a new connection could come in from the same old IP after removal.)</em>
<a class="jxr_linenumber" name="108" href="#108">108</a> <em class="jxr_javadoccomment"> * If in doubt, prune the old unused or stall keys from the child executor map</em>
<a class="jxr_linenumber" name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * periodically:</em>
<a class="jxr_linenumber" name="110" href="#110">110</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * &lt;pre&gt;</em>
<a class="jxr_linenumber" name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * RemoteAddressBasedOMATPE executor = ...;</em>
<a class="jxr_linenumber" name="113" href="#113">113</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * on every 3 seconds:</em>
<a class="jxr_linenumber" name="115" href="#115">115</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="116" href="#116">116</a> <em class="jxr_javadoccomment"> *   for (Iterator&amp;lt;Object&amp;gt; i = executor.getChildExecutorKeySet().iterator; i.hasNext();) {</em>
<a class="jxr_linenumber" name="117" href="#117">117</a> <em class="jxr_javadoccomment"> *       InetAddress ip = (InetAddress) i.next();</em>
<a class="jxr_linenumber" name="118" href="#118">118</a> <em class="jxr_javadoccomment"> *       if (there is no active connection from 'ip' now &amp;&amp;</em>
<a class="jxr_linenumber" name="119" href="#119">119</a> <em class="jxr_javadoccomment"> *           there has been no incoming connection from 'ip' for last 10 minutes) {</em>
<a class="jxr_linenumber" name="120" href="#120">120</a> <em class="jxr_javadoccomment"> *           i.remove();</em>
<a class="jxr_linenumber" name="121" href="#121">121</a> <em class="jxr_javadoccomment"> *       }</em>
<a class="jxr_linenumber" name="122" href="#122">122</a> <em class="jxr_javadoccomment"> *   }</em>
<a class="jxr_linenumber" name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * &lt;/pre&gt;</em>
<a class="jxr_linenumber" name="124" href="#124">124</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * If the expected maximum number of keys is small and deterministic, you could</em>
<a class="jxr_linenumber" name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * use a weak key map such as &lt;a href="<a href="http://viewvc.jboss.org/cgi-bin/viewvc.cgi/jbosscache/experimental/jsr166/src/jsr166y/ConcurrentWeakHashMap.java?view=markup" target="alexandria_uri">http://viewvc.jboss.org/cgi-bin/viewvc.cgi/jbosscache/experimental/jsr166/src/jsr166y/ConcurrentWeakHashMap.java?view=markup</a>"&gt;ConcurrentWeakHashMap&lt;/a&gt;</em>
<a class="jxr_linenumber" name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * or synchronized {@link WeakHashMap} instead of managing the life cycle of the</em>
<a class="jxr_linenumber" name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * keys by yourself.</em>
<a class="jxr_linenumber" name="129" href="#129">129</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="130" href="#130">130</a> <em class="jxr_javadoccomment"> * @author &lt;a href="<a href="http://www.jboss.org/netty/" target="alexandria_uri">http://www.jboss.org/netty/</a>"&gt;The Netty Project&lt;/a&gt;</em>
<a class="jxr_linenumber" name="131" href="#131">131</a> <em class="jxr_javadoccomment"> * @author &lt;a href="<a href="http://gleamynode.net/" target="alexandria_uri">http://gleamynode.net/</a>"&gt;Trustin Lee&lt;/a&gt;</em>
<a class="jxr_linenumber" name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * @author David M. Lloyd (david.lloyd@redhat.com)</em>
<a class="jxr_linenumber" name="133" href="#133">133</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * @version $Rev: 2308 $, $Date: 2010-06-17 23:23:59 +0900 (Thu, 17 Jun 2010) $</em>
<a class="jxr_linenumber" name="135" href="#135">135</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="136" href="#136">136</a> <em class="jxr_javadoccomment"> * @apiviz.landmark</em>
<a class="jxr_linenumber" name="137" href="#137">137</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="138" href="#138">138</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/jboss/netty/handler/execution/OrderedMemoryAwareThreadPoolExecutor.html">OrderedMemoryAwareThreadPoolExecutor</a> <strong class="jxr_keyword">extends</strong>
<a class="jxr_linenumber" name="139" href="#139">139</a>         <a href="../../../../../org/jboss/netty/handler/execution/MemoryAwareThreadPoolExecutor.html">MemoryAwareThreadPoolExecutor</a> {
<a class="jxr_linenumber" name="140" href="#140">140</a> 
<a class="jxr_linenumber" name="141" href="#141">141</a>     <em class="jxr_comment">// TODO Make OMATPE focus on the case where Channel is the key.</em>
<a class="jxr_linenumber" name="142" href="#142">142</a>     <em class="jxr_comment">//      Add a new less-efficient TPE that allows custom key.</em>
<a class="jxr_linenumber" name="143" href="#143">143</a> 
<a class="jxr_linenumber" name="144" href="#144">144</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> ConcurrentMap&lt;Object, Executor&gt; childExecutors = newChildExecutorMap();
<a class="jxr_linenumber" name="145" href="#145">145</a> 
<a class="jxr_linenumber" name="146" href="#146">146</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="147" href="#147">147</a> <em class="jxr_javadoccomment">     * Creates a new instance.</em>
<a class="jxr_linenumber" name="148" href="#148">148</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="149" href="#149">149</a> <em class="jxr_javadoccomment">     * @param corePoolSize          the maximum number of active threads</em>
<a class="jxr_linenumber" name="150" href="#150">150</a> <em class="jxr_javadoccomment">     * @param maxChannelMemorySize  the maximum total size of the queued events per channel.</em>
<a class="jxr_linenumber" name="151" href="#151">151</a> <em class="jxr_javadoccomment">     *                              Specify {@code 0} to disable.</em>
<a class="jxr_linenumber" name="152" href="#152">152</a> <em class="jxr_javadoccomment">     * @param maxTotalMemorySize    the maximum total size of the queued events for this pool</em>
<a class="jxr_linenumber" name="153" href="#153">153</a> <em class="jxr_javadoccomment">     *                              Specify {@code 0} to disable.</em>
<a class="jxr_linenumber" name="154" href="#154">154</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="155" href="#155">155</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../../org/jboss/netty/handler/execution/OrderedMemoryAwareThreadPoolExecutor.html">OrderedMemoryAwareThreadPoolExecutor</a>(
<a class="jxr_linenumber" name="156" href="#156">156</a>             <strong class="jxr_keyword">int</strong> corePoolSize, <strong class="jxr_keyword">long</strong> maxChannelMemorySize, <strong class="jxr_keyword">long</strong> maxTotalMemorySize) {
<a class="jxr_linenumber" name="157" href="#157">157</a>         <strong class="jxr_keyword">super</strong>(corePoolSize, maxChannelMemorySize, maxTotalMemorySize);
<a class="jxr_linenumber" name="158" href="#158">158</a>     }
<a class="jxr_linenumber" name="159" href="#159">159</a> 
<a class="jxr_linenumber" name="160" href="#160">160</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="161" href="#161">161</a> <em class="jxr_javadoccomment">     * Creates a new instance.</em>
<a class="jxr_linenumber" name="162" href="#162">162</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="163" href="#163">163</a> <em class="jxr_javadoccomment">     * @param corePoolSize          the maximum number of active threads</em>
<a class="jxr_linenumber" name="164" href="#164">164</a> <em class="jxr_javadoccomment">     * @param maxChannelMemorySize  the maximum total size of the queued events per channel.</em>
<a class="jxr_linenumber" name="165" href="#165">165</a> <em class="jxr_javadoccomment">     *                              Specify {@code 0} to disable.</em>
<a class="jxr_linenumber" name="166" href="#166">166</a> <em class="jxr_javadoccomment">     * @param maxTotalMemorySize    the maximum total size of the queued events for this pool</em>
<a class="jxr_linenumber" name="167" href="#167">167</a> <em class="jxr_javadoccomment">     *                              Specify {@code 0} to disable.</em>
<a class="jxr_linenumber" name="168" href="#168">168</a> <em class="jxr_javadoccomment">     * @param keepAliveTime         the amount of time for an inactive thread to shut itself down</em>
<a class="jxr_linenumber" name="169" href="#169">169</a> <em class="jxr_javadoccomment">     * @param unit                  the {@link TimeUnit} of {@code keepAliveTime}</em>
<a class="jxr_linenumber" name="170" href="#170">170</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="171" href="#171">171</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../../org/jboss/netty/handler/execution/OrderedMemoryAwareThreadPoolExecutor.html">OrderedMemoryAwareThreadPoolExecutor</a>(
<a class="jxr_linenumber" name="172" href="#172">172</a>             <strong class="jxr_keyword">int</strong> corePoolSize, <strong class="jxr_keyword">long</strong> maxChannelMemorySize, <strong class="jxr_keyword">long</strong> maxTotalMemorySize,
<a class="jxr_linenumber" name="173" href="#173">173</a>             <strong class="jxr_keyword">long</strong> keepAliveTime, TimeUnit unit) {
<a class="jxr_linenumber" name="174" href="#174">174</a>         <strong class="jxr_keyword">super</strong>(corePoolSize, maxChannelMemorySize, maxTotalMemorySize,
<a class="jxr_linenumber" name="175" href="#175">175</a>                 keepAliveTime, unit);
<a class="jxr_linenumber" name="176" href="#176">176</a>     }
<a class="jxr_linenumber" name="177" href="#177">177</a> 
<a class="jxr_linenumber" name="178" href="#178">178</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="179" href="#179">179</a> <em class="jxr_javadoccomment">     * Creates a new instance.</em>
<a class="jxr_linenumber" name="180" href="#180">180</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="181" href="#181">181</a> <em class="jxr_javadoccomment">     * @param corePoolSize          the maximum number of active threads</em>
<a class="jxr_linenumber" name="182" href="#182">182</a> <em class="jxr_javadoccomment">     * @param maxChannelMemorySize  the maximum total size of the queued events per channel.</em>
<a class="jxr_linenumber" name="183" href="#183">183</a> <em class="jxr_javadoccomment">     *                              Specify {@code 0} to disable.</em>
<a class="jxr_linenumber" name="184" href="#184">184</a> <em class="jxr_javadoccomment">     * @param maxTotalMemorySize    the maximum total size of the queued events for this pool</em>
<a class="jxr_linenumber" name="185" href="#185">185</a> <em class="jxr_javadoccomment">     *                              Specify {@code 0} to disable.</em>
<a class="jxr_linenumber" name="186" href="#186">186</a> <em class="jxr_javadoccomment">     * @param keepAliveTime         the amount of time for an inactive thread to shut itself down</em>
<a class="jxr_linenumber" name="187" href="#187">187</a> <em class="jxr_javadoccomment">     * @param unit                  the {@link TimeUnit} of {@code keepAliveTime}</em>
<a class="jxr_linenumber" name="188" href="#188">188</a> <em class="jxr_javadoccomment">     * @param threadFactory         the {@link ThreadFactory} of this pool</em>
<a class="jxr_linenumber" name="189" href="#189">189</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="190" href="#190">190</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../../org/jboss/netty/handler/execution/OrderedMemoryAwareThreadPoolExecutor.html">OrderedMemoryAwareThreadPoolExecutor</a>(
<a class="jxr_linenumber" name="191" href="#191">191</a>             <strong class="jxr_keyword">int</strong> corePoolSize, <strong class="jxr_keyword">long</strong> maxChannelMemorySize, <strong class="jxr_keyword">long</strong> maxTotalMemorySize,
<a class="jxr_linenumber" name="192" href="#192">192</a>             <strong class="jxr_keyword">long</strong> keepAliveTime, TimeUnit unit, ThreadFactory threadFactory) {
<a class="jxr_linenumber" name="193" href="#193">193</a>         <strong class="jxr_keyword">super</strong>(corePoolSize, maxChannelMemorySize, maxTotalMemorySize,
<a class="jxr_linenumber" name="194" href="#194">194</a>                 keepAliveTime, unit, threadFactory);
<a class="jxr_linenumber" name="195" href="#195">195</a>     }
<a class="jxr_linenumber" name="196" href="#196">196</a> 
<a class="jxr_linenumber" name="197" href="#197">197</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="198" href="#198">198</a> <em class="jxr_javadoccomment">     * Creates a new instance.</em>
<a class="jxr_linenumber" name="199" href="#199">199</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="200" href="#200">200</a> <em class="jxr_javadoccomment">     * @param corePoolSize          the maximum number of active threads</em>
<a class="jxr_linenumber" name="201" href="#201">201</a> <em class="jxr_javadoccomment">     * @param maxChannelMemorySize  the maximum total size of the queued events per channel.</em>
<a class="jxr_linenumber" name="202" href="#202">202</a> <em class="jxr_javadoccomment">     *                              Specify {@code 0} to disable.</em>
<a class="jxr_linenumber" name="203" href="#203">203</a> <em class="jxr_javadoccomment">     * @param maxTotalMemorySize    the maximum total size of the queued events for this pool</em>
<a class="jxr_linenumber" name="204" href="#204">204</a> <em class="jxr_javadoccomment">     *                              Specify {@code 0} to disable.</em>
<a class="jxr_linenumber" name="205" href="#205">205</a> <em class="jxr_javadoccomment">     * @param keepAliveTime         the amount of time for an inactive thread to shut itself down</em>
<a class="jxr_linenumber" name="206" href="#206">206</a> <em class="jxr_javadoccomment">     * @param unit                  the {@link TimeUnit} of {@code keepAliveTime}</em>
<a class="jxr_linenumber" name="207" href="#207">207</a> <em class="jxr_javadoccomment">     * @param threadFactory         the {@link ThreadFactory} of this pool</em>
<a class="jxr_linenumber" name="208" href="#208">208</a> <em class="jxr_javadoccomment">     * @param objectSizeEstimator   the {@link ObjectSizeEstimator} of this pool</em>
<a class="jxr_linenumber" name="209" href="#209">209</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="210" href="#210">210</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../../org/jboss/netty/handler/execution/OrderedMemoryAwareThreadPoolExecutor.html">OrderedMemoryAwareThreadPoolExecutor</a>(
<a class="jxr_linenumber" name="211" href="#211">211</a>             <strong class="jxr_keyword">int</strong> corePoolSize, <strong class="jxr_keyword">long</strong> maxChannelMemorySize, <strong class="jxr_keyword">long</strong> maxTotalMemorySize,
<a class="jxr_linenumber" name="212" href="#212">212</a>             <strong class="jxr_keyword">long</strong> keepAliveTime, TimeUnit unit,
<a class="jxr_linenumber" name="213" href="#213">213</a>             <a href="../../../../../org/jboss/netty/util/ObjectSizeEstimator.html">ObjectSizeEstimator</a> objectSizeEstimator, ThreadFactory threadFactory) {
<a class="jxr_linenumber" name="214" href="#214">214</a>         <strong class="jxr_keyword">super</strong>(corePoolSize, maxChannelMemorySize, maxTotalMemorySize,
<a class="jxr_linenumber" name="215" href="#215">215</a>                 keepAliveTime, unit, objectSizeEstimator, threadFactory);
<a class="jxr_linenumber" name="216" href="#216">216</a>     }
<a class="jxr_linenumber" name="217" href="#217">217</a> 
<a class="jxr_linenumber" name="218" href="#218">218</a>     <strong class="jxr_keyword">protected</strong> ConcurrentMap&lt;Object, Executor&gt; newChildExecutorMap() {
<a class="jxr_linenumber" name="219" href="#219">219</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> ConcurrentIdentityWeakKeyHashMap&lt;Object, Executor&gt;();
<a class="jxr_linenumber" name="220" href="#220">220</a>     }
<a class="jxr_linenumber" name="221" href="#221">221</a> 
<a class="jxr_linenumber" name="222" href="#222">222</a>     <strong class="jxr_keyword">protected</strong> Object getChildExecutorKey(<a href="../../../../../org/jboss/netty/channel/ChannelEvent.html">ChannelEvent</a> e) {
<a class="jxr_linenumber" name="223" href="#223">223</a>         <strong class="jxr_keyword">return</strong> e.getChannel();
<a class="jxr_linenumber" name="224" href="#224">224</a>     }
<a class="jxr_linenumber" name="225" href="#225">225</a> 
<a class="jxr_linenumber" name="226" href="#226">226</a>     <strong class="jxr_keyword">protected</strong> Set&lt;Object&gt; getChildExecutorKeySet() {
<a class="jxr_linenumber" name="227" href="#227">227</a>         <strong class="jxr_keyword">return</strong> childExecutors.keySet();
<a class="jxr_linenumber" name="228" href="#228">228</a>     }
<a class="jxr_linenumber" name="229" href="#229">229</a> 
<a class="jxr_linenumber" name="230" href="#230">230</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> removeChildExecutor(Object key) {
<a class="jxr_linenumber" name="231" href="#231">231</a>         <em class="jxr_comment">// FIXME: Succeed only when there is no task in the ChildExecutor's queue.</em>
<a class="jxr_linenumber" name="232" href="#232">232</a>         <em class="jxr_comment">//        Note that it will need locking which might slow down task submission.</em>
<a class="jxr_linenumber" name="233" href="#233">233</a>         <strong class="jxr_keyword">return</strong> childExecutors.remove(key) != <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="234" href="#234">234</a>     }
<a class="jxr_linenumber" name="235" href="#235">235</a> 
<a class="jxr_linenumber" name="236" href="#236">236</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="237" href="#237">237</a> <em class="jxr_javadoccomment">     * Executes the specified task concurrently while maintaining the event</em>
<a class="jxr_linenumber" name="238" href="#238">238</a> <em class="jxr_javadoccomment">     * order.</em>
<a class="jxr_linenumber" name="239" href="#239">239</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="240" href="#240">240</a>     @Override
<a class="jxr_linenumber" name="241" href="#241">241</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> doExecute(Runnable task) {
<a class="jxr_linenumber" name="242" href="#242">242</a>         <strong class="jxr_keyword">if</strong> (!(task instanceof ChannelEventRunnable)) {
<a class="jxr_linenumber" name="243" href="#243">243</a>             doUnorderedExecute(task);
<a class="jxr_linenumber" name="244" href="#244">244</a>         } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="245" href="#245">245</a>             <a href="../../../../../org/jboss/netty/handler/execution/ChannelEventRunnable.html">ChannelEventRunnable</a> r = (ChannelEventRunnable) task;
<a class="jxr_linenumber" name="246" href="#246">246</a>             getChildExecutor(r.getEvent()).execute(task);
<a class="jxr_linenumber" name="247" href="#247">247</a>         }
<a class="jxr_linenumber" name="248" href="#248">248</a>     }
<a class="jxr_linenumber" name="249" href="#249">249</a> 
<a class="jxr_linenumber" name="250" href="#250">250</a>     <strong class="jxr_keyword">private</strong> Executor getChildExecutor(<a href="../../../../../org/jboss/netty/channel/ChannelEvent.html">ChannelEvent</a> e) {
<a class="jxr_linenumber" name="251" href="#251">251</a>         Object key = getChildExecutorKey(e);
<a class="jxr_linenumber" name="252" href="#252">252</a>         Executor executor = childExecutors.get(key);
<a class="jxr_linenumber" name="253" href="#253">253</a>         <strong class="jxr_keyword">if</strong> (executor == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="254" href="#254">254</a>             executor = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/jboss/netty/handler/execution/OrderedMemoryAwareThreadPoolExecutor.html">ChildExecutor</a>();
<a class="jxr_linenumber" name="255" href="#255">255</a>             Executor oldExecutor = childExecutors.putIfAbsent(key, executor);
<a class="jxr_linenumber" name="256" href="#256">256</a>             <strong class="jxr_keyword">if</strong> (oldExecutor != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="257" href="#257">257</a>                 executor = oldExecutor;
<a class="jxr_linenumber" name="258" href="#258">258</a>             }
<a class="jxr_linenumber" name="259" href="#259">259</a>         }
<a class="jxr_linenumber" name="260" href="#260">260</a> 
<a class="jxr_linenumber" name="261" href="#261">261</a>         <em class="jxr_comment">// Remove the entry when the channel closes.</em>
<a class="jxr_linenumber" name="262" href="#262">262</a>         <strong class="jxr_keyword">if</strong> (e instanceof ChannelStateEvent) {
<a class="jxr_linenumber" name="263" href="#263">263</a>             <a href="../../../../../org/jboss/netty/channel/Channel.html">Channel</a> channel = e.getChannel();
<a class="jxr_linenumber" name="264" href="#264">264</a>             <a href="../../../../../org/jboss/netty/channel/ChannelStateEvent.html">ChannelStateEvent</a> se = (ChannelStateEvent) e;
<a class="jxr_linenumber" name="265" href="#265">265</a>             <strong class="jxr_keyword">if</strong> (se.getState() == ChannelState.OPEN &amp;&amp;
<a class="jxr_linenumber" name="266" href="#266">266</a>                 !channel.isOpen()) {
<a class="jxr_linenumber" name="267" href="#267">267</a>                 childExecutors.remove(channel);
<a class="jxr_linenumber" name="268" href="#268">268</a>             }
<a class="jxr_linenumber" name="269" href="#269">269</a>         }
<a class="jxr_linenumber" name="270" href="#270">270</a>         <strong class="jxr_keyword">return</strong> executor;
<a class="jxr_linenumber" name="271" href="#271">271</a>     }
<a class="jxr_linenumber" name="272" href="#272">272</a> 
<a class="jxr_linenumber" name="273" href="#273">273</a>     @Override
<a class="jxr_linenumber" name="274" href="#274">274</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> shouldCount(Runnable task) {
<a class="jxr_linenumber" name="275" href="#275">275</a>         <strong class="jxr_keyword">if</strong> (task instanceof ChildExecutor) {
<a class="jxr_linenumber" name="276" href="#276">276</a>             <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="277" href="#277">277</a>         }
<a class="jxr_linenumber" name="278" href="#278">278</a> 
<a class="jxr_linenumber" name="279" href="#279">279</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">super</strong>.shouldCount(task);
<a class="jxr_linenumber" name="280" href="#280">280</a>     }
<a class="jxr_linenumber" name="281" href="#281">281</a> 
<a class="jxr_linenumber" name="282" href="#282">282</a>     <strong class="jxr_keyword">void</strong> onAfterExecute(Runnable r, Throwable t) {
<a class="jxr_linenumber" name="283" href="#283">283</a>         afterExecute(r, t);
<a class="jxr_linenumber" name="284" href="#284">284</a>     }
<a class="jxr_linenumber" name="285" href="#285">285</a> 
<a class="jxr_linenumber" name="286" href="#286">286</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/jboss/netty/handler/execution/OrderedMemoryAwareThreadPoolExecutor.html">ChildExecutor</a> <strong class="jxr_keyword">implements</strong> Executor, Runnable {
<a class="jxr_linenumber" name="287" href="#287">287</a>         <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> LinkedList&lt;Runnable&gt; tasks = <strong class="jxr_keyword">new</strong> LinkedList&lt;Runnable&gt;();
<a class="jxr_linenumber" name="288" href="#288">288</a> 
<a class="jxr_linenumber" name="289" href="#289">289</a>         <a href="../../../../../org/jboss/netty/handler/execution/OrderedMemoryAwareThreadPoolExecutor.html">ChildExecutor</a>() {
<a class="jxr_linenumber" name="290" href="#290">290</a>             <strong class="jxr_keyword">super</strong>();
<a class="jxr_linenumber" name="291" href="#291">291</a>         }
<a class="jxr_linenumber" name="292" href="#292">292</a> 
<a class="jxr_linenumber" name="293" href="#293">293</a>         <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute(Runnable command) {
<a class="jxr_linenumber" name="294" href="#294">294</a>             <strong class="jxr_keyword">boolean</strong> needsExecution;
<a class="jxr_linenumber" name="295" href="#295">295</a>             <strong class="jxr_keyword">synchronized</strong> (tasks) {
<a class="jxr_linenumber" name="296" href="#296">296</a>                 needsExecution = tasks.isEmpty();
<a class="jxr_linenumber" name="297" href="#297">297</a>                 tasks.add(command);
<a class="jxr_linenumber" name="298" href="#298">298</a>             }
<a class="jxr_linenumber" name="299" href="#299">299</a> 
<a class="jxr_linenumber" name="300" href="#300">300</a>             <strong class="jxr_keyword">if</strong> (needsExecution) {
<a class="jxr_linenumber" name="301" href="#301">301</a>                 doUnorderedExecute(<strong class="jxr_keyword">this</strong>);
<a class="jxr_linenumber" name="302" href="#302">302</a>             }
<a class="jxr_linenumber" name="303" href="#303">303</a>         }
<a class="jxr_linenumber" name="304" href="#304">304</a> 
<a class="jxr_linenumber" name="305" href="#305">305</a>         <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> run() {
<a class="jxr_linenumber" name="306" href="#306">306</a>             Thread thread = Thread.currentThread();
<a class="jxr_linenumber" name="307" href="#307">307</a>             <strong class="jxr_keyword">for</strong> (;;) {
<a class="jxr_linenumber" name="308" href="#308">308</a>                 <strong class="jxr_keyword">final</strong> Runnable task;
<a class="jxr_linenumber" name="309" href="#309">309</a>                 <strong class="jxr_keyword">synchronized</strong> (tasks) {
<a class="jxr_linenumber" name="310" href="#310">310</a>                     task = tasks.getFirst();
<a class="jxr_linenumber" name="311" href="#311">311</a>                 }
<a class="jxr_linenumber" name="312" href="#312">312</a> 
<a class="jxr_linenumber" name="313" href="#313">313</a>                 <strong class="jxr_keyword">boolean</strong> ran = false;
<a class="jxr_linenumber" name="314" href="#314">314</a>                 beforeExecute(thread, task);
<a class="jxr_linenumber" name="315" href="#315">315</a>                 <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="316" href="#316">316</a>                     task.run();
<a class="jxr_linenumber" name="317" href="#317">317</a>                     ran = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="318" href="#318">318</a>                     onAfterExecute(task, <strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="319" href="#319">319</a>                 } <strong class="jxr_keyword">catch</strong> (RuntimeException e) {
<a class="jxr_linenumber" name="320" href="#320">320</a>                     <strong class="jxr_keyword">if</strong> (!ran) {
<a class="jxr_linenumber" name="321" href="#321">321</a>                         onAfterExecute(task, e);
<a class="jxr_linenumber" name="322" href="#322">322</a>                     }
<a class="jxr_linenumber" name="323" href="#323">323</a>                     <strong class="jxr_keyword">throw</strong> e;
<a class="jxr_linenumber" name="324" href="#324">324</a>                 } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="325" href="#325">325</a>                     <strong class="jxr_keyword">synchronized</strong> (tasks) {
<a class="jxr_linenumber" name="326" href="#326">326</a>                         tasks.removeFirst();
<a class="jxr_linenumber" name="327" href="#327">327</a>                         <strong class="jxr_keyword">if</strong> (tasks.isEmpty()) {
<a class="jxr_linenumber" name="328" href="#328">328</a>                             <strong class="jxr_keyword">break</strong>;
<a class="jxr_linenumber" name="329" href="#329">329</a>                         }
<a class="jxr_linenumber" name="330" href="#330">330</a>                     }
<a class="jxr_linenumber" name="331" href="#331">331</a>                 }
<a class="jxr_linenumber" name="332" href="#332">332</a>             }
<a class="jxr_linenumber" name="333" href="#333">333</a>         }
<a class="jxr_linenumber" name="334" href="#334">334</a>     }
<a class="jxr_linenumber" name="335" href="#335">335</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

